Skip to main content
Feedback

API Service documentation tab

Updated 23 July 2026

This topic describes the fields on the API Service component's Documentation tab.

Use the API Service Documentation tab to specify API metadata exposed upon deployment of the API Service component. This metadata is written to the API Service component's OpenAPI specification file. If you publish the component to the Developer Portal, this metadata is also visible to consumers there.

API Documentation tab.

Use these fields to keep your API's published documentation accurate and complete wherever the API Service component's metadata appears.